home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / mail / ADMail.lha / ADMail.doc < prev    next >
Encoding:
Text File  |  1995-04-14  |  17.6 KB  |  428 lines
  1.  
  2.                    _____   ___     ______
  3.                   /    /  /   |   /  /  /            /
  4.                  /____/  /    /  /     /  ____   *  /
  5.                 /    /  /    /  /     /  ____/  /  /
  6.                /    /  /____/  /     /  /___/  /  /
  7.  
  8.                  Amazing Developments Mail v1.01
  9.  
  10.                          By Simon Brown
  11.  
  12.                   (c) 1995 Amazing Developments
  13.  
  14.  
  15. Introduction
  16. ------------
  17.  
  18. Welcome to ADMail, the latest in fun and friendly programs from your friends
  19. here at Amazing Developments.
  20.  
  21. ADMail is a GadTools-based UUCP/SMTP electronic mail reader and poster,
  22. combining the ease of use of Intuition with the configurable cunningness of,
  23. er, something that's really configurable. And cunning.
  24.  
  25. My guess is, that if you've been able to download this archive, you'll know
  26. enough to be able to use the package...
  27.  
  28. ADMail is fully functional "out of the box" - I don't believe in crippled
  29. software, apart from the bits I haven't written the code for yet :)
  30.  
  31. Oh, and by the way - ADMail is SHAREWARE, as defined in section 4s of the
  32. enclosed FD-Copyright document, and worth a tenner of anybody's money if you
  33. ask me.
  34.  
  35. Therefore: if you use this program loads, you are required (and indeed,
  36. morally obliged) to send me a sum totalling no less than ten English pounds,
  37. taking into consideration all monetary conversion costs. You are welcome to
  38. send more if you wish...
  39.  
  40. For your tenner you will receive the splendiferous ADMaN, a combined mail/news
  41. package incorporating all of the features of ADMail, and which will probably
  42. not go on general release. This is what is known as "an incentive".
  43.  
  44. If you have an e-mail address (and it's pretty unlikely that you won't, let's
  45. face it) then send it along with the registration, and I'll e-mail ADMaN to
  46. you as soon as possible. Otherwise, you'll have to allow for postage and media
  47. costs.
  48.  
  49. How It Works
  50. ------------
  51.  
  52. ADMail is very simple to use. It is suggested that you run ADMail from a
  53. shell, or with IconX, so that any error information may be output to this
  54. shell. Most sendmail programs also output information, and that will go to
  55. this window too.
  56.  
  57. If you run it from Workbench, an output window will pop up whenever output
  58. needs to be displayed. So run it from IconX - it's less annoying! And besides,
  59. I've supplied you with a script and an icon (ta Raz).
  60.  
  61. When run, ADMail opens a window and attempts to read the current user's
  62. mailbox. The current user is defined by the environment variable USER, and the
  63. mailbox is stored in UUMAIL: (see Configuration).
  64.  
  65. When a mailbox is read, some information about each message is displayed in
  66. the list. The list will look a bit like this:
  67.  
  68.     From                  Subject                             Status  Lines
  69.  
  70.     Matthew Collins       ADMAIL                                 A     20
  71.     Simon Brown           Talking to myself again...            N       9
  72.     Dan Cannon            Re: ADMail                           L A     20
  73.     John Brown            Re: Hello.                             AF    22
  74.  
  75. Of these, the only bit that really needs explanation is the "Status" field.
  76. This displays the settings of a number of flags associated with the message.
  77.  
  78. The full list of flags, and their meanings, is as follows:
  79.  
  80.     N:  New message
  81.     O:  Old (unread) message
  82.     A:  Message which has been replied to
  83.     F:  Message which has been forwarded
  84.     L:  Message which has been logged (saved or printed)
  85.     D:  Message which is marked for deletion (removed when the mailbox is
  86.         next updated)
  87.  
  88.  
  89. To read a message, double-click on it, or use the Next and Previous commands
  90. to move through the messages and view each one, or use the left/right arrow
  91. keys to move to the message, followed by the View command. A new window will
  92. be opened, and the message contents, if recognised as displayable, will be
  93. displayed within.
  94.  
  95. For MIME, ADMail will display text/plain messages, with the us-ascii and
  96. the 9 ISO-8859 charsets (these charsets are NOT converted, however).
  97. It will display these IF they are encoded with one of: 7bit, 8bit, binary,
  98. or quoted-printable. The first three are not encoded forms, and are therefore
  99. displayed "as is". Quoted-printable messages are decoded before display.
  100.  
  101. If you want to display other types of MIME message in their proper form, you'll
  102. need to obtain and install Metamail. If Metamail is not installed, setting
  103. the environment variable "NoMetamail" (to anything) will cause ADMail to
  104. display the message, in its encoded form. Otherwise it will attempt to pass
  105. the message to Metamail, and probably fail horribly.
  106.  
  107. Note also that multipart messages are always passed to Metamail, regardless
  108. of their contents.
  109.  
  110. The menu options (and keyboard shortcuts) are:
  111.  
  112. Menu item                   Function                    Shortcut key
  113.  
  114. Project
  115.     Change...               Change mailbox                  C
  116.     Rescan Current          Reload contents of
  117.                             current mailbox
  118.     Preferences...          Program preferences
  119.                             Due for improvement
  120.                             (currently loads your config
  121.                             file into a text editor)
  122.     About...                Standard About box, with a
  123.                             button for mailing bug
  124.                             reports.
  125.     Quit                    Exits ADMail.
  126.  
  127. Message
  128.     View                    View current message            V or Return
  129.     Next                    Select next message             >
  130.                             from list and view it
  131.     Previous                Select previous message         <
  132.                             from list and view it
  133.     Save                    Save current message            S
  134.                             to new file
  135.     Print                   Send current message
  136.                             to printer
  137.     Delete                  Mark current message            D
  138.                             for deletion
  139.     Undelete                Unmark message marked           U
  140.                             for deletion
  141.  
  142. Mail
  143.     Send new                Compose and send new mail       M
  144.     Reply                   Compose and send reply          R
  145.                             to current message
  146.     Forward                 Forward current message         F
  147.                             to new recipient
  148.  
  149. A number of these commands are available on the button bank, if available (see
  150. Configuration).
  151.  
  152. Other keys:
  153.  
  154.     Up arrow:       Scroll message window up
  155.     Down arrow:     Scroll message window down
  156.     Shift+Up:       Scroll message window up 1 page
  157.     Shift+Down:     Scroll message window down 1 page
  158.     Left Arrow:     Select previous message (don't view)
  159.     Right Arrow:    Select next message (don't view)
  160.     TAB:            Activate mailbox select window (if open)
  161.  
  162. The above are all connected with the message list and message view windows.
  163. The mailbox select window does not have a menu strip, but the following keys
  164. are available:
  165.  
  166.     Up arrow:       Highlight previous mailbox
  167.     Down arrow:     Highlight next mailbox
  168.     Return:         Open highlighted mailbox and activate message list
  169.                     window
  170.     TAB:            Activate message list window
  171.  
  172. You should now hardly ever need to touch the mouse, if such is your desire.
  173.  
  174. Configuration
  175. -------------
  176.  
  177. Installation of ADMail is a slice of gateau. Simply copy the main program file
  178. to a location of your choice, and run it whenever you want to read your mail.
  179. As long as your variables are set up sensibly, it should work fine. The
  180. variables may be located in the global or local environment, or in the file
  181. "UULIB:Config", or in the file "S:UUConfig". They will be searched in that
  182. approximate order.
  183.  
  184. The variables it requires are:
  185.  
  186.     USER       Should contain your user ID (e.g. "simes").
  187.     HOME       Should point to a directory where you store things for your
  188.                mail account, e.g. signature files.
  189.     REALNAME   Should contain your real name (e.g. "Simon Brown").
  190.     NODENAME   Should contain your machine name (e.g. "amdev")
  191.     DOMAINNAME Should contain the domain your machine is in (e.g.
  192.                ".demon.co.uk")
  193.  
  194. Most of these are probably set up by your chosen Net software anyway.
  195.  
  196. If you wish, you can add custom headers to your mail messages. Create a
  197. file named ".mailheaders" and put the headers you want into it. Put this file
  198. into the same directory as your signature file (see below) and ADMail will
  199. include it with every outgoing message.
  200.  
  201. The configuration file is stored in $HOME/ADMail.config.
  202.  
  203. Just about everything is configurable about ADMail. Many of the defaults use
  204. the internal variables explained below.
  205.  
  206. Here are the configurable options:
  207.  
  208. Strings:
  209.  
  210.     Sendmail        Command string to call your sendmail program.
  211.                         Default "sendmail <$MSG -f $USER"
  212.     Salute          String placed at the start of replies.
  213.                         Default "Greetings, $FIRSTNAME."
  214.     ForwardIntro    String placed at the start of forwarded messages.
  215.                         Default "On $DATE, $NAME wrote:"
  216.     IndentPrefix    String placed at the beginning of each included line in a
  217.                     reply.
  218.                         Default "> "
  219.     SigDir          Directory where your signature and .mailheaders files lurk.
  220.                     I suggest you use $USER somewhere in this.
  221.                         Default "USR:$USER"
  222.     SigFile         The name of your signature file.
  223.                         Default ".signature"
  224.     RandSigHook     Name of command to generate your random signature. If
  225.                     RandomSigs is set, this command will be called just
  226.                     before the editor is loaded. This command should create
  227.                     a new signature file, corresponding to the dir/name you
  228.                     have chosen.
  229.                         Default "MakeSig"
  230.     Editor          Command string to call your editor.
  231.                         Default "$Editor" (this is an environment variable)
  232.     MBoxDir         Directory in which your mailboxes lurk.
  233.                         Default "UUMAIL:"
  234.  
  235. Switches:
  236.  
  237.     LogOutgoing     Whether to save outgoing mail into UUMAIL:<user>.sent.
  238.                         Default "Yes"
  239.     LogEncoded      Whether to store UUEncoded files in their entirety in the
  240.                     log file. Only valid if LogOutgoing is "Yes".
  241.                         Default "No"
  242.     IncludeFrom     Whether to include a From: header in the outgoing message.
  243.                     Necessary if your sendmail prog can't insert one itself.
  244.                         Default "No"
  245.     RandomSigs      Whether to generate a new signature automatically.
  246.                         Default "No"
  247.     SigDashes       Whether to insert "--" before your signature in a
  248.                     message.
  249.                         Default "Yes"
  250.     ShowDeleted     Whether to display items which are marked as deleted.
  251.                         Default "No"
  252.     SkipDeleted     Whether to skip over deleted items when using next/prev.
  253.                         Default "Yes"
  254.     ReloadOnResize  Whether to reload a displayed message when the message
  255.                     window is resized.
  256.                         Default "No"
  257.     PubScreen       Whether to open on the default public screen. If "No",
  258.                     ADMail will open its own screen, which will clone the WB
  259.                     screen's dimensions, and have 2 bitplanes (4 colours).
  260.                         Default "Yes"
  261.     ShowButtons     Whether to show the button bar at the bottom of the list
  262.                     window.
  263.                         Default "No"
  264.  
  265. Values:
  266.  
  267.     MsgListLeft     Sizing and placement settings for the message list window.
  268.     MsgListTop
  269.     MsgListWidth        Defaults: Depends on the default system font you use.
  270.     MsgListHeight       Under Topaz 8, it's around 640x110.
  271.  
  272.     MsgLeft         Sizing and placement settings for the message window.
  273.     MsgTop
  274.     MsgWidth            Defaults: Again, dependant on the system font.
  275.     MsgHeight           Under Topaz 8, about 640x140.
  276.  
  277.     TextWidth       The no. of columns of text to display. Replaces MsgWidth
  278.                     and MsgListWidth. If this option is present, the MsgWidth
  279.                     and MsgListWidth options will not be used. My preferred
  280.                     setting for this is 82.
  281.                         Default: None. The default window sizes are used
  282.                         instead.
  283.  
  284.     SelectLeft      Sizing and placement settings for the mbox select list.
  285.     SelectTop
  286.     SelectWidth         Defaults: Depends on the default system font.
  287.     SelectHeight        Under Topaz 8, about 320x110.
  288.  
  289. The first 7 of the string settings can use the internal variables.
  290.  
  291. These are:
  292.  
  293.     $MSG        Filename of temp. message file (only useable by Sendmail)
  294.     $USER       Your user id
  295.     $FIRSTNAME  First name of sender of current message
  296.     $NAME       Full name of sender of current message
  297.     $ADDRESS    E-Mail address of sender of current message
  298.     $DATE       Datestamp of current message
  299.     $MSGID      Message-ID of current message
  300.     $SUBJECT    Subject of current message
  301.     $INITIALS   Initials of sender of current message (occasionally looks a
  302.                 bit odd)
  303.  
  304. Note that most of these are dependent on there being a message currently
  305. selected - if there is not a message selected, they will not be parsed.
  306.  
  307. A # at the start of a line indicates a comment, and this line will be ignored.
  308. Putting the settings in quotes is not mandatory, but is probably a good idea.
  309. If you want a space at the end of the string, such as in IndentPrefix, then
  310. enclose the string in quotes or the space will be ignored.
  311.  
  312. The settings keywords are not case-sensitive, but the internal variable names
  313. MUST be in upper case, or they will not work.
  314.  
  315. The ones which cause things to be executed (Editor, SendMail, RandSigHook) can
  316. have environment variables as the command.
  317.  
  318. The default settings have been set so that ADMail should fit fairly
  319. comfortably on a standard 640x256 screen, as long as your system font is
  320. thinner than that nasty Topaz 8. If not, either overscan the screen, put up
  321. with wordwrapped mail messages, or switch to a thinner font. The mailbox
  322. select window will open over the message list window under the default
  323. settings.
  324.  
  325. Things yet to do
  326. ----------------
  327.  
  328. Things which are not yet in ADMail, but will be as soon as I get the chance to
  329. do them:
  330.  
  331. Command-line usage: So you can send an already-prepared message without having
  332. to bring the GUI up. A fairly high priority one.
  333.  
  334. Alias list: Not sure how I'll implement this one. You can get by if you use
  335. the sendmail aliases file, but that's just a stopgap measure.
  336.  
  337. PGP support: Some people want it, some aren't bothered. PGP-MIP should work
  338. with ADMail, though, so this isn't too high on the list.
  339.  
  340. Hook for post-editing script: I don't see the need, myself, but one person
  341. asked me to put one in. If you can think of a really pressing need for one of
  342. these, then e-mail me with a convincing explanation.
  343.  
  344. Bugs in ADMail
  345. --------------
  346.  
  347. I've nailed down almost all the bugs I've been told about, so this is a
  348. wonderful opportunity for you to find some more.
  349.  
  350. I've killed one or two since the last release - check the History list for
  351. more information.
  352.  
  353. To mail me a bug report, click on the "I've found a bug, me" button in the
  354. About requester.
  355.  
  356. Be sure and tell me everything relevant about your system - OS version,
  357. amount/type of RAM, processor type etc.
  358.  
  359. If you get any Enforcer hits, note down the hunk/offset of the ones shown as being
  360. caused by ADMail, and send that along, too.
  361.  
  362. The mystery bug:
  363. For some people, ADMail apparently locks up after loading a mailbox file.
  364. None of my other beta testers have reported this problem, and I have been
  365. unable to reproduce it. If anyone else encounters it, tell me at once.
  366. NB: I've made some changes to the mailbox-reading routine, and this
  367. problem may have disappeared because of this. If either of the two people
  368. who reported this bug originally discovers that it's now OK, let me know.
  369.  
  370. Acknowledgements
  371. ----------------
  372.  
  373. Profuse thanks must go to the following people:
  374.  
  375. The beta-testers:
  376.  
  377. Gareth Edwards, Gwynne Reddick, Phil Stewart-Jones, Tez Boyes, Jason Doig, Dan
  378. Cannon, Raz, James Lynn, Andy Tindall, Matthew Cowen, Simon Dainty, and
  379. everyone who downloaded beta 3 from ftp.demon. Also thanks to Raz for drawing
  380. the NewIcons icon for me.
  381.  
  382. The CBM technical bods:
  383.  
  384. For bringing us a smart machine and a splendid OS. A pox on Ali and all his
  385. works.
  386.  
  387. Everyone who was ever nice to me:
  388.  
  389. For being nice to me.
  390.  
  391. The people who sent in bug reports:
  392.  
  393. Hey, ADMail wouldn't be what it is without you.
  394.  
  395. About Simon Brown
  396. -----------------
  397.  
  398. Born at an early age in the northeast of England, Simon Brown has successfully
  399. reached the age of 22 without succumbing to fatal diseases or limb loss. He is
  400. currently struggling through the final year of an honours degree in Computer
  401. Science at the University of Teesside, and has big plans for the future.
  402. Moving out of Middlesbrough, for a start off.
  403.  
  404. Simon has produced a number of packages under the banner of Amazing
  405. Developments, his shareware label. The most notorious of these is probably
  406. Gibbereeze, which is available on a number of platforms and is almost totally
  407. useless. Other small utilities he has written include Neat, a text file
  408. reformatter, and FilePick, a program to pick random filenames.
  409.  
  410. Simon is approximately six feet tall, and rather too heavy for his own good.
  411. This is mainly due to his predeliction for pasta and Battenburg Treats. He has
  412. brown hair and eyes, and a permanent air of puzzlement at the world. He likes
  413. to drink tea, and vodka with fresh orange when someone else is buying.
  414.  
  415. The Amazing Developments contact address is:
  416.  
  417.         Simon Brown
  418.         28 Broadacres
  419.         Bardon Mill
  420.         HEXHAM
  421.         Northumberland
  422.         NE47 7EF
  423.         England.
  424.  
  425.         E-Mail: simes@amdev.demon.co.uk
  426.  
  427.  
  428.